home *** CD-ROM | disk | FTP | other *** search
/ Pluspack 1 / Caligari Corporation Pluspack1 1998.iso / TSX_SDK / tsxINC / tsxMNode.h < prev    next >
Encoding:
C/C++ Source or Header  |  1998-01-28  |  3.3 KB  |  83 lines
  1. //******************************************************************************
  2. //    File: tsxMNode.h
  3. //  Module: trueSpace eXtensions API
  4. //   Descr: Definition of tsxMNODE
  5. //******************************************************************************
  6.  
  7. #ifndef TSXMNODE_H
  8. #define TSXMNODE_H
  9.  
  10.  
  11. #include "tsxTypes.h"
  12.  
  13.  
  14. //------------------------------------------------------------------------------
  15. //------------------------------------------------------------------------------
  16.  
  17. // A tsxMNODE is the abstract type for Geometric Objects in a Scene.
  18. // An MNode adds the following features to a GNode:
  19. //     - Modification of Model Frame position and orientation,
  20. //     - Visibility.
  21. // All MNodes have a model frame that can be directly modified. TrueSpace
  22. // visualy displays the model frame through the position and orientation of
  23. // the MNode's Axes. TSXAPI allows direct modification of this model frame.
  24.  
  25.  
  26. //------------------------------------------------------------------------------
  27. //    MNode type check
  28. //------------------------------------------------------------------------------
  29.  
  30. // e_tsxTRUE if pSobj is a MNode
  31. TSXAPIFN tsxBOOL tsxIsMNode( tsxSOBJ* pSobj );
  32.  
  33.  
  34. //------------------------------------------------------------------------------
  35. //    Drawing/Rendering
  36. //------------------------------------------------------------------------------
  37.  
  38. // Polyhdera are the only visible object types in a photo-rendered scene (other
  39. // than lighting effects). Since Polyhdera may be members of Groups in a
  40. // hierarchy, TSXAPI allows a Group MNode to be rendered, or set (in)visible.
  41. // Only the Polyhdera members of the group are affected. Therefore, the following
  42. // operations are meaningful for Group MNodes only if they have some Polyhdera
  43. // as sub-objects.
  44.  
  45. // Returns e_tsxTRUE if pMNode is Visible in a rendered scene.
  46. // A Group object may return TRUE even if it does not have any
  47. // Polyhdera descendants.
  48. TSXAPIFN tsxBOOL tsxMNodeIsVisible( tsxMNODE* pMNode );
  49.  
  50. // Makes pMNode Visible. Effect on next Draw operation.
  51. TSXAPIFN void tsxMNodeSetVisible( tsxMNODE* pMNode );
  52.  
  53. // Makes pMNode Invisible. Effect on next Draw operation.
  54. TSXAPIFN void tsxMNodeSetInvisible( tsxMNODE* pMNode );
  55.  
  56.  
  57. //------------------------------------------------------------------------------
  58. //    Model-frame Axes
  59. //------------------------------------------------------------------------------
  60.  
  61. // The Axes define the object's own model frame (as different from the world
  62. // frame). This frame is used for rigid body transformations
  63. // (translation/rotation/scaling) (see tsxGNode).
  64.  
  65. // Returns e_tsxTRUE if MNode has its Axes displayed in tS.
  66. TSXAPIFN tsxBOOL tsxMNodeAreAxesVisible( tsxMNODE* pMNode );
  67.  
  68. // Toggles (On/Off) the display of the current object's axes, if applicable.
  69. TSXAPIFN void tsxCurrobjToggleAxes();
  70.  
  71. // Set the position of MNode's axes.
  72. // Does not update views.
  73. TSXAPIFN void tsxMNodeSetAxesPosition( tsxMNODE* pMNode, CtsxVector3f* posn );
  74.  
  75. // Set the orientation of MNode's axes.
  76. // `axes' must point to valid (orthogonal, unit) axes.
  77. // Does not update views.
  78. TSXAPIFN void tsxMNodeSetAxesOrientation( tsxMNODE* pMNode, CtsxAxes3f* axes );
  79.  
  80.  
  81. //******************************************************************************
  82. #endif //TSXMNODE_H
  83.